vcTopology

vcTopology represents the topology data of tessellated geometry and can be used to generate simple and complex geometry, for example NURBS, meshes and splines.

See in: Overview

Module: vcGeometry

Parent: -

Children -

Referenced by: vcTriangleSet.Topology

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

Name	Type	Access	Description
CurveCount	Integer	R	Gets the total number of curves in set.
CurveLoopCount	Integer	R	Gets the total number of curve loops in set.
FaceCount	Integer	R	Gets the total number of faces in set.
PointCount	Integer	R	Gets the total number of points considered boundary-corners in mesh, for example curve ends. See more If the set is not a mesh, gives zero. Note: To get the total number of points in set, use PointCount in vcTriangleSet.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
getCurveCurveLoop	Integer	Integer curveIndex	Returns the index of the curve loop that the curve belongs to in the set. See more Parameters: curveIndex (int): The index of the curve. Exceptions: IndexError: When the curveIndex is out of bounds. Returns: int: The index of the curve loop.
getCurveFace	Integer	Integer curveIndex	Returns the index of the face that the curve belongs to in the set. See more Parameters: curveIndex (int): The index of the curve. Exceptions: IndexError: When the curveIndex is out of bounds. Returns: int: The index of the face.
getCurveLength	Real	Integer curveIndex	Returns the length of a curve at a given index in the set. That is, the total distance along the curve. See more Parameters: curveIndex (int): The index of the curve. Exceptions: IndexError: When the curveIndex is out of bounds. Returns: float: The length of the curve.
getCurveLoopCurve	Integer	Integer curveLoopIndex, Integer relativeCurveIndex	Returns the absolute index of an inner curve loop relative to its curve loop. See more Parameters: curveLoopIndex (int): The index of the curve loop. relativeCurveIndex (int): The index of the curve in the curve loop. Exceptions: IndexError: When the curveLoopIndex is out of bounds. Returns: int: The absolute index of the curve loop.
getCurveLoopCurveCount	Integer	Integer curveLoopIndex	Returns the total number of inner curve loops for a curve loop of face in set. See more Parameters: curveLoopIndex (int): The index of the curve loop. Exceptions: IndexError: When the curveLoopIndex is out of bounds. Returns: int: Number of inner curve loops.
getCurveNeighbor	Integer	Integer curveIndex	Returns the index of a curve neighboring another curve in the set. See more Parameters: curveIndex (int): The index of the curve. Exceptions: IndexError: When the curveIndex is out of bounds. Returns: int: The index of the neighboring curve.
getCurvePointCount	Integer	Integer curveIndex	Returns the total number of points for a curve at a given index in the set. See more Parameters: curveIndex (int): The index of the curve. Exceptions: IndexError: When the curveIndex is out of bounds. Returns: int: The number of points in the curve.
getCurvePointIndex	Integer	Integer curveIndex, Integer relativePointIndex	Returns the absolute index of point relative to its curve in the set. See more Parameters: curveIndex (int): The index of the curve. relativePointIndex (int): The index of the point. Relative to the curve. Exceptions: IndexError: When the curveIndex is out of bounds. Returns: int: The absolute point index.
getCurvePosition	vcMatrix	Integer curveIndex, Real distance	Returns the position matrix of a point on the curve at the given distance along the curve. See more Details about the position matrix: - Position vector: Actual position of the point on the curve. - Normal vector: Direction of the curve at the given point (derivative of the curve position). - Orientation vector: Aligned to face inwards of the curve's face. - Approach vector: Surface normal of the face at the curve position. Parameters: curveIndex (int): The index of the curve. distance (float): The distance along the curve. Exceptions: IndexError: When the curveIndex is out of bounds. Returns: vcMatrix: The position matrix of the point.
getCurvePositions	list[vcMatrix]	Integer curveIndex	Returns a list of position matrices for points along the curve. See more Parameters: curveIndex (int): The index of the curve. Exceptions: IndexError: When the curveIndex is out of bounds. Returns: list[vcMatrix]: List of the position matrices of the points.
getFaceBound	vcBoundingBox	Integer faceIndex	Returns the bounding box of the face. See more Parameters: faceIndex (int): The index of the face. Exceptions: IndexError: When the faceIndex is out of bounds. Returns: vcBoundingBox: The bounding box.
getFaceCurveLoop	Integer	Integer faceIndex, Integer relativeCurveLoopIndex	Returns the absolute index of a curve loop relative to its face in set. See more Parameters: faceIndex (int): The index of the face. relativeCurveLoopIndex (int): The relative index of the curve loop. Exceptions: IndexError: When the faceIndex is out of bounds. IndexError: When the relativeCurveLoopIndex is out of bounds. Returns: int: The absolute index of the curve loop.
getFaceCurveLoopCount	Integer	Integer faceIndex	Returns the total number of curve loops in a face. See more Parameters: faceIndex (int): The index of the face. Exceptions: IndexError: When the faceIndex is out of bounds. Returns: int: The number of curve loops.
getFacePlaneIntersections	list[list[vcMatrix]]	Integer faceIndex, vcMatrix plane	Returns a list containing lists of position matrices for points where a defined plane intersects a face. See more Each time a plane goes through hole in face a new list is added, thereby allowing you to infer hole points on face-plane intersection. Details about the position matrix: - Position vector: Actual position of point intersection. - Normal vector: Direction along plane intersecting face. - Orientation vector: Projected from normal of plane to surface of face using face derivate for projected direction. - Approach vector: Surface normal of face. Parameters: faceIndex (int): The index of the face. plane (vcMatrix): The plane. Exceptions: IndexError: When the faceIndex is out of bounds. Returns: list[list[vcMatrix]]: List of curves. Each curve is a list of point position matrices.
getFaceStartTriangle	Integer	Integer faceIndex	Returns the absolute index of first triangle of a face in set. See more Parameters: faceIndex (int): The index of the face. Exceptions: IndexError: When the faceIndex is out of bounds. Returns: int: The absolute index of the first triangle.
getFaceTriangleCount	Integer	Integer faceIndex	Returns the total number of triangles of a face. See more Parameters: faceIndex (int): The index of the face. Exceptions: IndexError: When the faceIndex is out of bounds. Returns: int: The number of triangles.
getPoint	vcVector	Integer pointIndex	Returns the position vector of a curve end (corner point) at a given index relative to either its curve or face. See more Parameters: pointIndex (int): The index of the point. Exceptions: IndexError: When the pointIndex is out of bounds. Returns: vcVector: The position of the point.
isCurveCircular	Boolean	Integer curveIndex	Checks whether a curve at a given index in set is circular (where start and end points are same). See more Parameters: faceIndex (int): The index of the face. Exceptions: IndexError: When the faceIndex is out of bounds. Returns: bool: True if a curve circular; otherwise returns False.